Skip to content

Parse qiskit-addon-obp addon content#5260

Open
eharvey328 wants to merge 3 commits into
mainfrom
emh/addon-obp
Open

Parse qiskit-addon-obp addon content#5260
eharvey328 wants to merge 3 commits into
mainfrom
emh/addon-obp

Conversation

@eharvey328

@eharvey328 eharvey328 commented Jun 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • uses the new addons pipeline to convert the qiskit-addon-obp content into markdown for the platform docs

preview content: https://qiskit.github.io/documentation/pr-5260/docs/addons/qiskit-addon-obp/

@review-notebook-app

review-notebook-app Bot commented Jun 11, 2026

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@eharvey328 eharvey328 marked this pull request as draft June 11, 2026 23:30
@eharvey328 eharvey328 changed the title [WIP] Parse qiskit-addon-obp addon content Parse qiskit-addon-obp addon content Jun 17, 2026
@abbycross

abbycross commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

@eharvey328 I notice the link to the release notes is broken, under Deprecation policy. The path has /api/ instead of /addons/ (not sure which is right!)

@eharvey328

eharvey328 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

@eharvey328 I notice the link to the release notes is broken, under Deprecation policy. The path has /api/ instead of /addons/ (not sure which is right!)

It's only broken in the preview because preview can't render api docs. Both /docs/api/addon-name/release-notes and /docs/addons/addon-name/release-notes are valid since we show it in both.

@eharvey328

eharvey328 commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

@eharvey328 I notice the link to the release notes is broken, under Deprecation policy. The path has /api/ instead of /addons/ (not sure which is right!)

It's only broken in the preview because preview can't render api docs. Both /docs/api/addon-name/release-notes and /docs/addons/addon-name/release-notes are valid since we show it in both.

@abbycross After clarification, it should be /docs/api/addon-name/release-notes. The release-notes at /addons won't exist, it will be a link to the /api page

Base automatically changed from emh/addons-content to main June 22, 2026 17:34
@eharvey328 eharvey328 marked this pull request as ready for review June 22, 2026 18:27
kaelynj
kaelynj previously approved these changes Jun 23, 2026
View reviewed changes

@kaelynj kaelynj left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thank you! 🚀

@eharvey328

eharvey328 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

We need to wait for the addon changes to be merged into stable/0.3 before merging

@kaelynj

kaelynj commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

We need to wait for the addon changes to be merged into stable/0.3 before merging

@eharvey328 just heard from the addons team that the doc changes to OBP are done and we can update these

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kaelynj kaelynj kaelynj left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

Docs Planning
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@eharvey328 @abbycross @kaelynj